Add Vorwerk integration #45749

trunneml · 2021-01-30T16:45:59Z

Proposed change

New Integration to bring back Vorwerk Kobold vacum cleaner support.
Before #44031 it was possible to use the neato integration.

It's possible to configure the integration by the User Config Flow in the UI with E-Mail and Code like the Vorwerk IOS app or by adding the SERIAL+SECRET_KEY of the robot in your configuration.yml. (Serial and secret can be fetched with pybotvac for example.)

VR200 is working. VR300 should work too, but without the map functionality as this needs OAuth and the current Vorwerk + Auth0 setup is somehow strange. It uses the id_token in a Auth0Bearer Authorization Header. And when calling a token refresh Python complains about the scope of the new token.

The custom_clean service supports zone cleaning. This should work with a VR300, but I can't test it as I only have the VR200.

I'm a developer, but new in writing home assistant integrations. Let me know if I should change or add something.

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Example entry for `configuration.yaml`:

# Example configuration.yaml
# This is optional. You can configure this integration via config flow from the ui.
vorwerk:
   - name: Mein VR
     serial: <serial>
     secret: !secret vorwerk_secret
     endpoint: <optional>

Additional information

This PR is an Integration for this feature request:
https://community.home-assistant.io/t/creation-of-vorwerk-kobold-component/253166/12

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
The code has been formatted using Black (black --fast homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
Untested files have been added to .coveragerc.

The integration reached or maintains the following Integration Quality Scale:

No score or internal
🥈 Silver
🥇 Gold
🏆 Platinum

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

homeassistant · 2021-01-30T16:46:01Z

Hi @trunneml,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

trunneml · 2021-01-30T16:57:27Z

Hi @trunneml,

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

Done

cgarwood

Good start 😃 - just handful of lint errors and a few additional comments.

homeassistant/components/vorwerk/translations/de.json

homeassistant/components/vorwerk/translations/en.json

homeassistant/components/vorwerk/__init__.py

homeassistant/components/vorwerk/config_flow.py

homeassistant/components/vorwerk/manifest.json

homeassistant/components/vorwerk/vacuum.py

cgarwood · 2021-01-30T17:16:28Z

Tests will be needed for the config flow as well

trunneml · 2021-01-30T17:32:53Z

Tests will be needed for the config flow as well

Where can I found a tutorial or the documentation ?

cgarwood · 2021-01-30T17:45:15Z

Check the tests/components folder in the repo, any integration with a config flow should have a test_config_flow.py file you can take a look at 🙂

trunneml · 2021-01-30T17:47:31Z

Check the tests/components folder in the repo, any integration with a config flow should have a test_config_flow.py file you can take a look at 🙂

Hope, I will find the time this week. :)

trunneml · 2021-01-30T18:23:25Z

@cgarwood can you tell me whats the correct way to fix the hassfest and Check all requirements failures?

trunneml · 2021-02-11T18:05:11Z

Checks passed :)

trunneml · 2021-07-30T13:48:40Z

@cgarwood @eavanvalkenburg Anything new? Could you merge my Pull Request? Is anything missing?

cgarwood · 2021-08-07T23:24:53Z

Good from my standpoint, but probably good for one of the more experienced reviewers to give it a look over.

trunneml · 2021-10-18T17:15:35Z

@cgarwood I integrated all requested changes. But the PR is still in "Awaiting requested changes" on the https://github.com/home-assistant/core/projects/5#card-55498357 board. What is missing? How is the future process to integrate this PR?

epenet · 2021-11-09T09:13:00Z

.coveragerc

+    homeassistant/components/vorwerk/__init__.py
+    homeassistant/components/vorwerk/vacuum.py


It is not compulsory, but since new integrations can take a while to get merged, I suggest that you take the opportunity to move to 100% coverage whilst the reviews are in progress.

Suggested change

homeassistant/components/vorwerk/__init__.py

homeassistant/components/vorwerk/vacuum.py

I will improve that over Christmas.

What is there to do? Just removing these lines? I want to help.

gjohansson-ST

Some comments

gjohansson-ST · 2022-01-06T10:54:57Z

homeassistant/components/vorwerk/__init__.py

+async def async_setup(hass: HomeAssistantType, config: ConfigType) -> bool:
+    """Set up the Vorwerk component."""
+    hass.data[VORWERK_DOMAIN] = {}
+
+    if VORWERK_DOMAIN in config:
+        hass.async_create_task(
+            hass.config_entries.flow.async_init(
+                VORWERK_DOMAIN,
+                context={"source": SOURCE_IMPORT},
+                data=config[VORWERK_DOMAIN],
+            )
+        )
+
+    return True


Remove as not needed for new integrations

gjohansson-ST · 2022-01-06T11:01:58Z

homeassistant/components/vorwerk/config_flow.py

+            ),
+        )
+
+    async def async_step_code(self, user_input: dict[str, Any] = None) -> FlowResult:


Suggested change

async def async_step_code(self, user_input: dict[str, Any] = None) -> FlowResult:

async def async_step_code(self, user_input: dict[str, Any] | None = None) -> FlowResult:

gjohansson-ST · 2022-01-06T11:03:14Z

homeassistant/components/vorwerk/config_flow.py

+                return self.async_create_entry(
+                    title=self._email,
+                    data={
+                        CONF_EMAIL: self._email,
+                        CONF_TOKEN: self._session.token,
+                        VORWERK_ROBOTS: robots,
+                    },
+                )


Move outside of try

Then an extra if is needed. I don't think that makes the code more readable.

It is compulsory to move it out of the try block, but you can use try...except...else form

@epenet I will try that.

gjohansson-ST · 2022-01-06T11:03:47Z

homeassistant/components/vorwerk/config_flow.py

+    async def async_step_import(self, user_input: dict[str, Any]) -> FlowResult:
+        """Import a config flow from configuration."""
+        unique_id = "from configuration"
+        data = {VORWERK_ROBOTS: user_input}
+
+        await self.async_set_unique_id(unique_id)
+        self._abort_if_unique_id_configured(data)
+
+        _LOGGER.info("Creating new Vorwerk robot config entry")
+        return self.async_create_entry(
+            title="from configuration",
+            data=data,
+        )


New integration needs no import

gjohansson-ST · 2022-01-06T11:05:02Z

homeassistant/components/vorwerk/const.py

+VORWERK_ROBOT_TRAITS = "traits"
+VORWERK_ROBOT_ENDPOINT = "endpoint"
+
+VORWERK_PLATFORMS = ["vacuum"]


Use Platform enum https://github.com/home-assistant/core/blob/dev/homeassistant/const.py#L22

bdraco

Please resolve conflicts. Thanks 👍

twartzek · 2022-03-02T19:36:05Z

Is any progress planned? I really would like to integrate the VR300 into my smart home, so I really appreciate your idea and work to integrate it.

trunneml · 2022-03-02T19:43:05Z

Yes, but my PR is now over one year old and the feed back loop from HA is quite slow.
I'm currently very busy. I hope find the time to rebase this branch next month.
You can use my custom integration to integrated your VR300 right now (see my other GitHub repository).

frenck · 2022-06-23T19:51:55Z

@trunneml Friendly notification/ping, the review comments from @gjohansson-ST haven't been touched/implemented/processed yet and there is a merge conflict. Would you have time to pick this PR up again?

../Frenck

trunneml · 2022-08-10T10:55:53Z

@frenck HI thanks for the reminder. I'm quite busy currently, but I will try to fix this. But after over one year to get this integration into Home-Assistant I'm questioning if this PR is the correct way.

Neato and Vorwerk Vacuum cleaners are both based on pybotvac and act the same way. The only difference is the authentication flow.
My idea was to just copy the neato integration and fix the authentication flow. But after all the reviews it's a whole new integration that has nothing to do with the neato anymore.

Please don't get me wrong all review findings were correct and the code is better now. But now it is no longer a fork of the neato integration. It is more a recode of it and that was not my intention when I started this PR.

Maybe it is a better idea to add the Vorwerk-Auth0 authentication to the neato integration. @dshokouhi and @Santober what do you think about this idea? Could you help me?

The ConfigFlow in this PR works for over one year now and I also have a working pybotvac patch, where the PasswordlessSession is based on the OAuthSession, that should work with Home Assistant like the neato OAuthSession.

What I'm not familiar with is the Home Assistant oauth2 token handling. Who could help me with that part?

frenck · 2023-01-17T14:56:39Z

Alright, considering the above response I think we can conclude this PR by itself will not be moving forwards. Therefore, I'll go ahead and close it.

../Frenck

trunneml · 2023-01-17T15:00:30Z

@frenck: as I didn't get feedback from @dshokouhi and completly forking from neato doesn't makes sense to me, you can close this PR.

homeassistant added the cla-needed label Jan 30, 2021

probot-home-assistant bot added new-integration integration: vorwerk labels Jan 30, 2021

project-bot bot added this to Needs review in Dev Jan 30, 2021

homeassistant added cla-signed and removed cla-needed labels Jan 30, 2021

cgarwood changed the title ~~Vorwerk~~ Add Vorwerk integration Jan 30, 2021

cgarwood requested changes Jan 30, 2021

View reviewed changes

Dev automation moved this from Needs review to Review in progress Jan 30, 2021

trunneml force-pushed the vorwerk branch from cb4179d to f73d10a Compare January 30, 2021 18:16

trunneml force-pushed the vorwerk branch 2 times, most recently from 26cbacb to 8773d1d Compare January 31, 2021 15:26

trunneml requested a review from cgarwood January 31, 2021 16:55

trunneml force-pushed the vorwerk branch 6 times, most recently from a5fceaa to 1dd8205 Compare February 11, 2021 17:30

cgarwood added the Ready for review label Feb 11, 2021

MartinHjelmare added this to Incoming in New Integrations Feb 23, 2021

MartinHjelmare moved this from Incoming to Needs followup review in New Integrations Feb 23, 2021

cgarwood moved this from Awaiting Requested Changes to Needs followup review in New Integrations Oct 18, 2021

rytilahti added the second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. label Nov 8, 2021

project-bot bot moved this from Review in progress to Second opinion wanted in Dev Nov 8, 2021

epenet reviewed Nov 9, 2021

View reviewed changes

trunneml force-pushed the vorwerk branch 2 times, most recently from 96b699d to 873c410 Compare December 26, 2021 13:36

trunneml added 3 commits December 26, 2021 21:05

Adds vorwerk component

a006327

Use DataUpdateCoordinator

e77213e

Use DeviceInfo, pybotvac, CODEOWNERS and remove device_state_attributes

4b9b7aa

trunneml force-pushed the vorwerk branch from 699cc67 to 4b9b7aa Compare December 26, 2021 21:06

gjohansson-ST requested changes Jan 6, 2022

View reviewed changes

Dev automation moved this from Second opinion wanted to Review in progress Jan 6, 2022

New Integrations automation moved this from Needs followup review to Awaiting Requested Changes Jan 6, 2022

bdraco added needs followup review and removed second-opinion-wanted Add this label when a reviewer needs a second opinion from another member. labels Jan 17, 2022

bdraco requested changes Jan 17, 2022

View reviewed changes

frenck closed this Jan 17, 2023

Dev automation moved this from Review in progress to Cancelled Jan 17, 2023

New Integrations automation moved this from Awaiting Requested Changes to Cancelled Jan 17, 2023

home-assistant bot removed the Ready for review label Jan 17, 2023

github-actions bot locked and limited conversation to collaborators Jan 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Vorwerk integration #45749

Add Vorwerk integration #45749

trunneml commented Jan 30, 2021 •

edited

homeassistant commented Jan 30, 2021

trunneml commented Jan 30, 2021

cgarwood left a comment

cgarwood commented Jan 30, 2021

trunneml commented Jan 30, 2021 •

edited

cgarwood commented Jan 30, 2021

trunneml commented Jan 30, 2021

trunneml commented Jan 30, 2021

trunneml commented Feb 11, 2021

trunneml commented Jul 30, 2021

cgarwood commented Aug 7, 2021

trunneml commented Oct 18, 2021

epenet Nov 9, 2021

trunneml Nov 29, 2021

tofuSCHNITZEL Nov 29, 2021

gjohansson-ST left a comment

gjohansson-ST Jan 6, 2022

gjohansson-ST Jan 6, 2022

gjohansson-ST Jan 6, 2022

trunneml Jan 6, 2022

epenet Jan 6, 2022

trunneml Jan 6, 2022

gjohansson-ST Jan 6, 2022

gjohansson-ST Jan 6, 2022

bdraco left a comment

twartzek commented Mar 2, 2022

trunneml commented Mar 2, 2022

frenck commented Jun 23, 2022

trunneml commented Aug 10, 2022

frenck commented Jan 17, 2023

trunneml commented Jan 17, 2023

	async def async_step_code(self, user_input: dict[str, Any] = None) -> FlowResult:
	async def async_step_code(self, user_input: dict[str, Any] \| None = None) -> FlowResult:

Add Vorwerk integration #45749

Add Vorwerk integration #45749

Conversation

trunneml commented Jan 30, 2021 • edited

Proposed change

Type of change

Example entry for configuration.yaml:

Additional information

Checklist

homeassistant commented Jan 30, 2021

trunneml commented Jan 30, 2021

cgarwood left a comment

Choose a reason for hiding this comment

cgarwood commented Jan 30, 2021

trunneml commented Jan 30, 2021 • edited

cgarwood commented Jan 30, 2021

trunneml commented Jan 30, 2021

trunneml commented Jan 30, 2021

trunneml commented Feb 11, 2021

trunneml commented Jul 30, 2021

cgarwood commented Aug 7, 2021

trunneml commented Oct 18, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gjohansson-ST left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bdraco left a comment

Choose a reason for hiding this comment

twartzek commented Mar 2, 2022

trunneml commented Mar 2, 2022

frenck commented Jun 23, 2022

trunneml commented Aug 10, 2022

frenck commented Jan 17, 2023

trunneml commented Jan 17, 2023

trunneml commented Jan 30, 2021 •

edited

Example entry for `configuration.yaml`:

trunneml commented Jan 30, 2021 •

edited